package heatmap

Import Path
	github.com/K-Phoen/grabana/heatmap (on go.dev)

Dependency Relation
	imports 9 packages, and imported by 2 packages


Involved Source Files

	    heatmap.go


Package-Level Type Names (total 4)


	/* sort by:  |  */
	
		DataFormatMode represents the data format modes.

		
			func DataFormat(format DataFormatMode) Option
		
			const TimeSeries
			const TimeSeriesBuckets


	
		Heatmap represents a heatmap panel.

		
			Builder *sdk.Panel
		
			func New(title string, options ...Option) (*Heatmap, error)


	
		LegendOption allows to configure a legend.

		
			func Legend(opts ...LegendOption) Option
		
			const Hide


	
		Option represents an option that can be used to configure a heatmap panel.

		
			func DataFormat(format DataFormatMode) Option
			func DataSource(source string) Option
			func Description(content string) Option
			func Height(height string) Option
			func HideTooltip() Option
			func HideTooltipHistogram() Option
			func HideXAxis() Option
			func HideZeroBuckets() Option
			func HighlightCards() Option
			func Legend(opts ...LegendOption) Option
			func Links(panelLinks ...links.Link) Option
			func NoHighlightCards() Option
			func Repeat(repeat string) Option
			func RepeatDirection(direction sdk.RepeatDirection) Option
			func ReverseYBuckets() Option
			func ShowZeroBuckets() Option
			func Span(span float32) Option
			func TooltipDecimals(decimals int) Option
			func Transparent() Option
			func WithGraphiteTarget(query string, options ...graphite.Option) Option
			func WithInfluxDBTarget(query string, options ...influxdb.Option) Option
			func WithPrometheusTarget(query string, options ...prometheus.Option) Option
			func WithStackdriverTarget(target *stackdriver.Stackdriver) Option
			func YAxis(opts ...axis.Option) Option
		
			func New(title string, options ...Option) (*Heatmap, error)
			func github.com/K-Phoen/grabana/row.WithHeatmap(title string, options ...Option) row.Option




Package-Level Functions (total 25)


	
		DataFormat sets how the data should be interpreted.


	
		DataSource sets the data source to be used by the panel.


	
		Description annotates the current visualization with a human-readable description.


	
		Height sets the height of the panel, in pixels. Example: "400px".


	
		HideTooltip prevents the tooltip from being displayed.


	
		HideTooltipHistogram prevents the histograms from being displayed in tooltips.
		Histogram represents the distribution of the bucket values for the specific timestamp.


	
		HideXAxis prevents the X-axis from being displayed.


	
		HideZeroBuckets hides "zero" buckets.


	
		HighlightCards highlights bucket cards.


	
		Legend defines what should be shown in the legend.


	
		New creates a new heatmap panel.


	
		NoHighlightCards disables the highlighting of bucket cards.


	
		Repeat configures repeating a panel for a variable


	
		RepeatDirection configures repeating vertical or horizontal


	
		ReverseYBuckets reverses the order of bucket on the Y-axis.


	
		ShowZeroBuckets forces the display of "zero" buckets.


	
		Span sets the width of the panel, in grid units. Should be a positive
		number between 1 and 12. Example: 6.


	
		TooltipDecimals sets the number of decimals to be displayed in tooltips.


	
		Transparent makes the background transparent.


	
		WithGraphiteTarget adds a Graphite target to the table.


	
		WithInfluxDBTarget adds an InfluxDB target to the graph.


	
		WithPrometheusTarget adds a prometheus query to the graph.


	
		WithStackdriverTarget adds a stackdriver query to the graph.


	
		YAxis configures the Y axis.




Package-Level Constants (total 3)


	
		Hide keeps the legend from being displayed.


	
		Each time series already represents a Y-Axis bucket.


	
		Grafana does the bucketing by going through all time series values